<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	<head>
		<meta http-equiv="content-type" content="text/html; charset=utf-8" />
		<meta name="generator" content="JsDoc Toolkit" />
		
		<title>CKFinder.dataTypes.Folder - CKFinder 2 JavaScript API Documentation</title>

		<style type="text/css">
			/* default.css */
body
{
	font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
}

.header
{
	clear: both;
	background-color: #ccc;
	padding: 8px;
}

h1
{
	font-size: 150%;
	font-weight: bold;
	padding: 0;
	margin: 1em 0 0 .3em;
}

hr
{
	border: none 0;
	border-top: 1px solid #7F8FB1;
	height: 1px;
}

pre.code
{
	display: block;
	padding: 8px;
	border: 1px dashed #ccc;
}

#index
{
	margin-top: 24px;
	float: left;
	width: 230px;
	position: absolute;
	left: 8px;
	background-color: #F3F3F3;
	padding: 8px;
}

#content
{
	margin-left: 260px;
}

.classList
{
	list-style-type: none;
	padding: 0;
	margin: 0 0 0 8px;
	font-family: arial, sans-serif;
	font-size: 1em;
	overflow: auto;
}

.classList li
{
	padding: 0;
	margin: 0 0 8px 0;
}

.summaryTable { width: 100%; }

h1.classTitle
{
	font-size:170%;
	line-height:130%;
}

h2 { font-size: 110%; }
caption, div.sectionTitle
{
	background-color: #7F8FB1;
	color: #fff;
	font-size:130%;
	text-align: left;
	padding: 2px 6px 2px 6px;
	border: 1px #7F8FB1 solid;
}

div.sectionTitle { margin-bottom: 8px; }
.summaryTable thead { display: none; }

.summaryTable td
{
	vertical-align: top;
	padding: 4px;
	border-bottom: 1px #7F8FB1 solid;
	border-right: 1px #7F8FB1 solid;
}

/*col#summaryAttributes {}*/
.summaryTable td.attributes
{
	border-left: 1px #7F8FB1 solid;
	width: 140px;
	text-align: right;
}

td.attributes, .fixedFont
{
	line-height: 15px;
	color: #002EBE;
	font-family: "Courier New",Courier,monospace;
	font-size: 13px;
}

.summaryTable td.nameDescription
{
	text-align: left;
	font-size: 13px;
	line-height: 15px;
}

.summaryTable td.nameDescription, .description
{
	line-height: 15px;
	padding: 4px;
	padding-left: 4px;
}

.summaryTable { margin-bottom: 8px; }

ul.inheritsList
{
	list-style: square;
	margin-left: 20px;
	padding-left: 0;
}

.detailList {
	margin-left: 20px;
	line-height: 15px;
}
.detailList dt { margin-left: 20px; }

.detailList .heading
{
	font-weight: bold;
	padding-bottom: 6px;
	margin-left: 0;
}

.light, td.attributes, .light a:link, .light a:visited
{
	color: #777;
	font-style: italic;
}

.fineprint
{
	text-align: right;
	font-size: 10px;
}

		</style>
	</head>

	<body>
<!-- ============================== header ================================= -->	
		<!-- begin static/header.html -->
		<div id="header">
	<h1>CKFinder 2 JavaScript API Documentation</h1>
	<hr />
</div>

		<!-- end static/header.html -->

<!-- ============================== classes index ============================ -->
		<div id="index">
			<!-- begin publish.classesIndex -->
			<div>
	<a href="../index.html">Code Index</a>
</div>
<hr />
<h2>Namespaces</h2>
<ul class="classList">
	
		
	
		
			<li>
				<a href="../symbols/CKFinder.html">CKFinder</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.ajax.html">CKFinder.ajax</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.config.html">CKFinder.config</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dataTypes.html">CKFinder.dataTypes</a>
			</li>
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
			<li>
				<a href="../symbols/CKFinder.dom.html">CKFinder.dom</a>
			</li>
		
	
		
	
		
	
		
	
		
	
		
			<li>
				<a href="../symbols/CKFinder.env.html">CKFinder.env</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.tools.html">CKFinder.tools</a>
			</li>
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
			<li>
				<a href="../symbols/CKFinderAPI.html">CKFinderAPI</a>
			</li>
		
	
</ul>
<h2>Classes</h2>
<ul class="classList">
	
		
	
		
	
		
	
		
	
		
	
		
			<li>
				<a href="../symbols/CKFinder.dataTypes.Acl.html">CKFinder.dataTypes.Acl</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dataTypes.BasketFolder.html">CKFinder.dataTypes.BasketFolder</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dataTypes.Connector.html">CKFinder.dataTypes.Connector</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dataTypes.File.html">CKFinder.dataTypes.File</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dataTypes.Folder.html">CKFinder.dataTypes.Folder</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dataTypes.ResourceType.html">CKFinder.dataTypes.ResourceType</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dialog.html">CKFinder.dialog</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dialog.definition.html">CKFinder.dialog.definition</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dialog.definition.button.html">CKFinder.dialog.definition.button</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dialog.definition.checkbox.html">CKFinder.dialog.definition.checkbox</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dialog.definition.content.html">CKFinder.dialog.definition.content</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dialog.definition.contentObject.html">CKFinder.dialog.definition.contentObject</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dialog.definition.file.html">CKFinder.dialog.definition.file</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dialog.definition.fileButton.html">CKFinder.dialog.definition.fileButton</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dialog.definition.hbox.html">CKFinder.dialog.definition.hbox</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dialog.definition.html.html">CKFinder.dialog.definition.html</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dialog.definition.radio.html">CKFinder.dialog.definition.radio</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dialog.definition.select.html">CKFinder.dialog.definition.select</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dialog.definition.textarea.html">CKFinder.dialog.definition.textarea</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dialog.definition.textInput.html">CKFinder.dialog.definition.textInput</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dialog.definition.uiElement.html">CKFinder.dialog.definition.uiElement</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dialog.definition.vbox.html">CKFinder.dialog.definition.vbox</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dialog.definitionObject.html">CKFinder.dialog.definitionObject</a>
			</li>
		
	
		
	
		
			<li>
				<a href="../symbols/CKFinder.dom.document.html">CKFinder.dom.document</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dom.domObject.html">CKFinder.dom.domObject</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dom.element.html">CKFinder.dom.element</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dom.node.html">CKFinder.dom.node</a>
			</li>
		
	
		
	
		
	
		
			<li>
				<a href="../symbols/CKFinder.ui.dialog.button.html">CKFinder.ui.dialog.button</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.ui.dialog.checkbox.html">CKFinder.ui.dialog.checkbox</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.ui.dialog.file.html">CKFinder.ui.dialog.file</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.ui.dialog.fileButton.html">CKFinder.ui.dialog.fileButton</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.ui.dialog.hbox.html">CKFinder.ui.dialog.hbox</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.ui.dialog.html.html">CKFinder.ui.dialog.html</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.ui.dialog.labeledElement.html">CKFinder.ui.dialog.labeledElement</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.ui.dialog.radio.html">CKFinder.ui.dialog.radio</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.ui.dialog.select.html">CKFinder.ui.dialog.select</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.ui.dialog.textarea.html">CKFinder.ui.dialog.textarea</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.ui.dialog.textInput.html">CKFinder.ui.dialog.textInput</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.ui.dialog.uiElement.html">CKFinder.ui.dialog.uiElement</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.ui.dialog.vbox.html">CKFinder.ui.dialog.vbox</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.xml.html">CKFinder.xml</a>
			</li>
		
	
		
	
</ul>
<hr />
			<!-- end publish.classesIndex -->
		</div>
		
		<div id="content">
<!-- ============================== class title ============================ -->
			<h1 class="classTitle">
				
				Class CKFinder.dataTypes.Folder
			</h1>

<!-- ============================== class summary ========================== -->			
			<p class="description">
				
				
			
				
				
			</p>

<!-- ============================== constructor summary ==================== -->			
			
			<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class CKFinder.dataTypes.Folder.">
				<caption>Class Summary</caption>
				<thead>
					<tr>
						<th scope="col">Constructor Attributes</th>
						<th scope="col">Constructor Name and Description</th>
					</tr>
				</thead>
				<tbody>
					<tr>
						<td class="attributes">&nbsp;</td>
						<td class="nameDescription" >
							<div class="fixedFont">
								<b><a href="../symbols/CKFinder.dataTypes.Folder.html#constructor">CKFinder.dataTypes.Folder</a></b>(app, type, name, path, url, hasChildren, acl)
							</div>
							<div class="description">Folder data type.</div>
						</td>
					</tr>
				</tbody>
			</table>
			

<!-- ============================== properties summary ===================== -->
			

				
				

				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class CKFinder.dataTypes.Folder.">
					<caption>Field Summary</caption>
					<thead>
						<tr>
							<th scope="col">Field Attributes</th>
							<th scope="col">Field Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								CKFinder.dataTypes.Folder.<b><a href="../symbols/CKFinder.dataTypes.Folder.html#.isBasket">isBasket</a></b>
								</div>
								<div class="description">Indicated that this folder is the Basket folder.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								<b><a href="../symbols/CKFinder.dataTypes.Folder.html#acl">acl</a></b>
								</div>
								<div class="description">User permissions inside of a folder.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								<b><a href="../symbols/CKFinder.dataTypes.Folder.html#childFolders">childFolders</a></b>
								</div>
								<div class="description">Array of child folders.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								<b><a href="../symbols/CKFinder.dataTypes.Folder.html#hasChildren">hasChildren</a></b>
								</div>
								<div class="description">Indicates whether folder has child folders.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								<b><a href="../symbols/CKFinder.dataTypes.Folder.html#index">index</a></b>
								</div>
								<div class="description">Folder's number in the folders array.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								<b><a href="../symbols/CKFinder.dataTypes.Folder.html#isDirty">isDirty</a></b>
								</div>
								<div class="description">Indicates whether folder has been changed (renamed, removed).</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								<b><a href="../symbols/CKFinder.dataTypes.Folder.html#isOpened">isOpened</a></b>
								</div>
								<div class="description">Indicates whether folder is opened.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								<b><a href="../symbols/CKFinder.dataTypes.Folder.html#isRoot">isRoot</a></b>
								</div>
								<div class="description">Indicates whether folder is a resource type.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								<b><a href="../symbols/CKFinder.dataTypes.Folder.html#name">name</a></b>
								</div>
								<div class="description">Folder name.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								<b><a href="../symbols/CKFinder.dataTypes.Folder.html#parent">parent</a></b>
								</div>
								<div class="description">Parent folder.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								<b><a href="../symbols/CKFinder.dataTypes.Folder.html#type">type</a></b>
								</div>
								<div class="description">Name of resource type where folder belongs to.</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
			

<!-- ============================== methods summary ======================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class CKFinder.dataTypes.Folder.">
					<caption>Method Summary</caption>
					<thead>
						<tr>
							<th scope="col">Method Attributes</th>
							<th scope="col">Method Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinder.dataTypes.Folder.html#close">close</a></b>()
								</div>
								<div class="description">Closes a folder.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinder.dataTypes.Folder.html#createNewFolder">createNewFolder</a></b>(newFolderName)
								</div>
								<div class="description">Creates new subfolder.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinder.dataTypes.Folder.html#deselect">deselect</a></b>()
								</div>
								<div class="description">Deselects a folder.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinder.dataTypes.Folder.html#getChildren">getChildren</a></b>(callback, force)
								</div>
								<div class="description">Returns child folders.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinder.dataTypes.Folder.html#getFiles">getFiles</a></b>(callback)
								</div>
								<div class="description">Request list of files in a folder.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinder.dataTypes.Folder.html#getNestingLevel">getNestingLevel</a></b>()
								</div>
								<div class="description">Returns nesting level of a folder.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinder.dataTypes.Folder.html#getPath">getPath</a></b>()
								</div>
								<div class="description">Returns path to a folder.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinder.dataTypes.Folder.html#getResourceType">getResourceType</a></b>()
								</div>
								<div class="description">Returns resource type of this folder.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinder.dataTypes.Folder.html#getUploadUrl">getUploadUrl</a></b>()
								</div>
								<div class="description">Returns url to the server connector used to upload files.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinder.dataTypes.Folder.html#getUrl">getUrl</a></b>()
								</div>
								<div class="description">Returns Url to a folder.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinder.dataTypes.Folder.html#isSelected">isSelected</a></b>()
								</div>
								<div class="description">Checks whether folder is selected.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinder.dataTypes.Folder.html#mapLoadedDescendants">mapLoadedDescendants</a></b>(callback)
								</div>
								<div class="description">Recurrently calls callback on all <strong>loaded</strong> children (of any depth).</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinder.dataTypes.Folder.html#open">open</a></b>(noLoad)
								</div>
								<div class="description">Opens a folder.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinder.dataTypes.Folder.html#remove">remove</a></b>()
								</div>
								<div class="description">Deletes a folder (from the server).</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinder.dataTypes.Folder.html#rename">rename</a></b>(New)
								</div>
								<div class="description">Renames a folder.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinder.dataTypes.Folder.html#select">select</a></b>()
								</div>
								<div class="description">Selects a folder.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinder.dataTypes.Folder.html#showFiles">showFiles</a></b>(selectedFilename)
								</div>
								<div class="description">Displays files in a folder to the user.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinder.dataTypes.Folder.html#toggle">toggle</a></b>()
								</div>
								<div class="description">Toggle between opening and closing a folder.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinder.dataTypes.Folder.html#toString">toString</a></b>()
								</div>
								<div class="description">Returns a string representation of a folder.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinder.dataTypes.Folder.html#updateReference">updateReference</a></b>()
								</div>
								<div class="description">Update folder reference if needed.</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
			

<!-- ============================== events summary ======================== -->
			

<!-- ============================== constructor details ==================== -->		
			
			<div class="details"><a name="constructor"> </a>
				<div class="sectionTitle">
					Class Detail
				</div>
				
				<div class="fixedFont" style="float:left">
						<b>CKFinder.dataTypes.Folder</b>(app, type, name, path, url, hasChildren, acl)
				</div>

				<div style="float:right">
					<span class="heading">Since:</span>
						
							2.0
						
				</div>
				<div style="clear:both"></div>
				
				<div class="description">
					Folder data type.<div style="padding:10px;margin:10px;border:1px #000 solid;background:#E0E0E0">Note: the CKFinder.dataTypes namespace is not directly accessible (CKFinder.dataTypes is undefined).<br />Data types are used internally by CKFinder and returned by many functions, like <a href="../symbols/CKFinderAPI.html#getSelectedFolder">CKFinderAPI#getSelectedFolder</a>.</div><style type="text/css">.details .detailList {display:none;} </style>
					
				</div>
				
				
				
					
						<pre class="code">var folder = api.getSelectedFolder();if ( folder )	alert( folder.getUrl() );</pre>
					
				
				
				
				
					
						<dl class="detailList">
						<dt class="heading">Parameters:</dt>
						
							<dt>
								<span class="light fixedFont">{Undefined}</span> <b>app</b>
								
							</dt>
								<dd></dd>
						
							<dt>
								<span class="light fixedFont">{Undefined}</span> <b>type</b>
								
							</dt>
								<dd></dd>
						
							<dt>
								<span class="light fixedFont">{Undefined}</span> <b>name</b>
								
							</dt>
								<dd></dd>
						
							<dt>
								<span class="light fixedFont">{Undefined}</span> <b>path</b>
								
							</dt>
								<dd></dd>
						
							<dt>
								<span class="light fixedFont">{Undefined}</span> <b>url</b>
								
							</dt>
								<dd></dd>
						
							<dt>
								<span class="light fixedFont">{Undefined}</span> <b>hasChildren</b>
								
							</dt>
								<dd></dd>
						
							<dt>
								<span class="light fixedFont">{Undefined}</span> <b>acl</b>
								
							</dt>
								<dd></dd>
						
						</dl>
					
					
					
					
					
					

			</div>
			

<!-- ============================== field details ========================== -->		
			
				<div class="sectionTitle">
					Field Detail
				</div>
				
					<a name=".isBasket"> </a>
					<div class="fixedFont" style="float:left">&lt;static&gt; 
					
					<span class="light">{Boolean}</span>
					<span class="light">CKFinder.dataTypes.Folder.</span><b>isBasket</b>
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Indicated that this folder is the Basket folder.
						
					</div>
					
					
						<pre class="code"><span style="color:red">NO EXAMPLE AVAILABLE</span></pre>
					

						
						
						

					<hr />
				
					<a name="acl"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{<a href="../symbols/CKFinder.dataTypes.Acl.html">CKFinder.dataTypes.Acl</a>}</span>
					<b>acl</b>
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						User permissions inside of a folder.
						
					</div>
					
					
					
						
							<pre class="code">alert( api.getSelectedFolder().acl.folderView );</pre>
						
					
					

						
						
						

					<hr />
				
					<a name="childFolders"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{Array}</span>
					<b>childFolders</b>
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Array of child folders.
						
					</div>
					
					
					
						
					
					

						
						
						

					<hr />
				
					<a name="hasChildren"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{Boolean}</span>
					<b>hasChildren</b>
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Indicates whether folder has child folders.
						
					</div>
					
					
					
						
							<pre class="code">alert( api.getSelectedFolder().hasChildren );</pre>
						
					
					

						
						
						

					<hr />
				
					<a name="index"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{Integer}</span>
					<b>index</b>
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Folder's number in the folders array.
						
					</div>
					
					
					
						
					
					

						
						
						

					<hr />
				
					<a name="isDirty"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{Boolean}</span>
					<b>isDirty</b>
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Indicates whether folder has been changed (renamed, removed).
						
					</div>
					
					
					
						
							<pre class="code">alert( api.getSelectedFolder().isDirty );</pre>
						
					
					

						
						
						

					<hr />
				
					<a name="isOpened"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{Boolean}</span>
					<b>isOpened</b>
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Indicates whether folder is opened.
						
					</div>
					
					
					
						
							<pre class="code">alert( api.getSelectedFolder().isOpened );</pre>
						
					
					

						
						
						

					<hr />
				
					<a name="isRoot"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{Boolean}</span>
					<b>isRoot</b>
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Indicates whether folder is a resource type.
						
					</div>
					
					
					
						
							<pre class="code">alert( api.getSelectedFolder().isRoot );</pre>
						
					
					

						
						
						

					<hr />
				
					<a name="name"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{String}</span>
					<b>name</b>
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Folder name.
						
					</div>
					
					
					
						
					
					

						
						
						

					<hr />
				
					<a name="parent"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{<a href="../symbols/CKFinder.dataTypes.Folder.html">CKFinder.dataTypes.Folder</a>}</span>
					<b>parent</b>
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Parent folder. Resource types don't have parent folder (parent is <code>null</code>).
						
					</div>
					
					
					
						
							<pre class="code">alert( api.getSelectedFolder().parent );</pre>
						
					
					

						
						
						

					<hr />
				
					<a name="type"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{String}</span>
					<b>type</b>
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Name of resource type where folder belongs to.
						
					</div>
					
					
					
						
					
					

						
						
						

					
				
			

<!-- ============================== method details ========================= -->		
			
				<div class="sectionTitle">
					Method Detail
				</div>
				
					<a name="close"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{Undefined}</span>
					<b>close</b>()
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Closes a folder.
						
					</div>
					
					
					
						
							<pre class="code">api.getSelectedFolder().close();</pre>
						
					
					
					
						
						
						
						
						
						

					<hr />
				
					<a name="createNewFolder"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{Undefined}</span>
					<b>createNewFolder</b>(newFolderName)
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Creates new subfolder.
						
					</div>
					
					
					
						
							<pre class="code">var folder = api.getSelectedFolder();folder.createNewFolder( 'newDirectory' );</pre>
						
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>newFolderName</b>
									
								</dt>
								<dd>New folder name.</dd>
							
							</dl>
						
						
						
						
						
						

					<hr />
				
					<a name="deselect"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{Undefined}</span>
					<b>deselect</b>()
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Deselects a folder.
						
					</div>
					
					
					
						
							<pre class="code">api.getSelectedFolder().deselect();</pre>
						
					
					
					
						
						
						
						
						
						

					<hr />
				
					<a name="getChildren"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{Array}</span>
					<b>getChildren</b>(callback, force)
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Returns child folders.
						
					</div>
					
					
					
						
							<pre class="code">api.getSelectedFolder().getChildren( function( folders ) {	api.log( "Loaded " + folders.length + " folders" );}, true);</pre>
						
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Function}</span> <b>callback</b>
									
								</dt>
								<dd>The function to be called on all child folders.</dd>
							
								<dt>
									<span class="light fixedFont">{Boolean}</span> <b>force</b>
									
								</dt>
								<dd>Force getting folder list from the server.</dd>
							
							</dl>
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Array}</span> </dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="getFiles"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{Undefined}</span>
					<b>getFiles</b>(callback)
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Request list of files in a folder.
						
					</div>
					
					
					
						
							<pre class="code">api.getSelectedFolder().getFiles( function( files ) {		var folderSize = 0;		for ( var i = 0 ; i < files.length ; i++ )			folderSize += files[i].size;		api.openMsgDialog( "Size of all files in a folder: " + folderSize + "KB" );	}, true);</pre>
						
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Function}</span> <b>callback</b>
									
								</dt>
								<dd>The function to be called on all files.</dd>
							
							</dl>
						
						
						
						
						
						

					<hr />
				
					<a name="getNestingLevel"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{Undefined}</span>
					<b>getNestingLevel</b>()
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Returns nesting level of a folder.
						
					</div>
					
					
					
						
							<pre class="code">api.getSelectedFolder().getNestingLevel();</pre>
						
					
					
					
						
						
						
						
						
						

					<hr />
				
					<a name="getPath"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{String}</span>
					<b>getPath</b>()
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Returns path to a folder.
						
					</div>
					
					
						<pre class="code"><span style="color:red">NO EXAMPLE AVAILABLE</span></pre>
					
					
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{String}</span> Path to a folder.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="getResourceType"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{<a href="../symbols/CKFinder.dataTypes.ResourceType.html">CKFinder.dataTypes.ResourceType</a>}</span>
					<b>getResourceType</b>()
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Returns resource type of this folder.
						
					</div>
					
					
					
						
							<pre class="code">var resourceType = api.getSelectedFolder().getResourceType();</pre>
						
					
					
					
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{<a href="../symbols/CKFinder.dataTypes.ResourceType.html">CKFinder.dataTypes.ResourceType</a>}</span> </dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="getUploadUrl"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{String}</span>
					<b>getUploadUrl</b>()
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Returns url to the server connector used to upload files.
						
					</div>
					
					
					
						
					
					
					
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{String}</span> Upload url.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="getUrl"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{String}</span>
					<b>getUrl</b>()
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Returns Url to a folder.
						
					</div>
					
					
					
						
					
					
					
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{String}</span> Url to a folder.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="isSelected"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{Boolean}</span>
					<b>isSelected</b>()
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Checks whether folder is selected.
						
					</div>
					
					
					
						
					
					
					
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Boolean}</span> True if selected.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="mapLoadedDescendants"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{Undefined}</span>
					<b>mapLoadedDescendants</b>(callback)
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Recurrently calls callback on all <strong>loaded</strong> children (of any depth).
						
					</div>
					
					
					
						
							<pre class="code">var folder = api.getSelectedFolder();folder.mapLoadedDescendants( function( child ) {	alert(child.getUrl());} );</pre>
						
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Function}</span> <b>callback</b>
									
								</dt>
								<dd></dd>
							
							</dl>
						
						
						
						
						
						

					<hr />
				
					<a name="open"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{Undefined}</span>
					<b>open</b>(noLoad)
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Opens a folder.
						
					</div>
					
					
					
						
							<pre class="code">var folder = api.getSelectedFolder();if ( folder && folder.hasChildren )	folder.childFolders[0].open();</pre>
						
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Boolean}</span> <b>noLoad</b>
									
								</dt>
								<dd>Don't expand folder if it wasn't loaded yet.</dd>
							
							</dl>
						
						
						
						
						
						

					<hr />
				
					<a name="remove"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{Undefined}</span>
					<b>remove</b>()
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Deletes a folder (from the server).
						
					</div>
					
					
					
						
							<pre class="code">var folder = api.getSelectedFolder();folder.remove();</pre>
						
					
					
					
						
						
						
						
						
						

					<hr />
				
					<a name="rename"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{Undefined}</span>
					<b>rename</b>(New)
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Renames a folder.
						
					</div>
					
					
					
						
							<pre class="code">var folder = api.getSelectedFolder();folder.rename( 'New name' );</pre>
						
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>New</b>
									
								</dt>
								<dd>folder name.</dd>
							
							</dl>
						
						
						
						
						
						

					<hr />
				
					<a name="select"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{Undefined}</span>
					<b>select</b>()
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Selects a folder.
						
					</div>
					
					
					
						
							<pre class="code">api.getSelectedFolder().parent.select();</pre>
						
					
					
					
						
						
						
						
						
						

					<hr />
				
					<a name="showFiles"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{Undefined}</span>
					<b>showFiles</b>(selectedFilename)
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Displays files in a folder to the user.
						
					</div>
					
					
					
						
							<pre class="code">// Display files in a parent folder.var parent = api.getSelectedFolder().parent;parent.select();parent.showFiles();</pre>
						
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>selectedFilename</b>
									
								</dt>
								<dd>Name of the file to select (optional).</dd>
							
							</dl>
						
						
						
						
						
						

					<hr />
				
					<a name="toggle"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{Undefined}</span>
					<b>toggle</b>()
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Toggle between opening and closing a folder.
						
					</div>
					
					
					
						
							<pre class="code">var folder = api.getSelectedFolder();folder.close();// Calling toggle() on closed folder will open it again.folder.toggle();</pre>
						
					
					
					
						
						
						
						
						
						

					<hr />
				
					<a name="toString"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{String}</span>
					<b>toString</b>()
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Returns a string representation of a folder.
						
					</div>
					
					
					
						
					
					
					
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{String}</span> Path to a folder.</dd>
							
							</dl>
						
						
						
							<dl class="detailList">
							<dt class="heading">See:</dt>
							
								<dd><a href="../symbols/CKFinder.dataTypes.Folder.html#getPath">CKFinder.dataTypes.Folder#getPath</a></dd>
							
							</dl>
						

					<hr />
				
					<a name="updateReference"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{Undefined}</span>
					<b>updateReference</b>()
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Update folder reference if needed.Use it folder (or it's parent) could be reloaded since creating the reference.
						
					</div>
					
					
						<pre class="code"><span style="color:red">NO EXAMPLE AVAILABLE</span></pre>
					
					
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Undefined}</span> CKFinder.dataTypes.Folder</dd>
							
							</dl>
						
						
						

					
				
			

			<!-- ============================== event details ========================= -->		
			

			<hr />
		</div>
		
<!-- ============================== footer ================================= -->
		<div class="fineprint" style="clear:both">
	Copyright &copy; 2007-2015, <a href="http://cksource.com/">CKSource</a> - Frederico Knabben. All rights reserved.
</div>

	</body>
</html>
